-
Notifications
You must be signed in to change notification settings - Fork 345
Ensure default groups for docs are sorted alphabetically #2132
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
📦 Docs artifacts are ready: https://github.com/elixir-lang/ex_doc/actions/runs/15817040972/artifacts/3380425421 |
Are you planning to send a PR for this too? :) You can also amend this one if you prefer! |
If we have to fix it then yes I'll update this PR. |
Yes, I should probably preserve it to avoid breaking changes, unless it would add a lot of complexity or complications. I am hoping it is rather just swapping operands somewhere :D |
Yeah ok, it should not be that hard. |
@josevalim Well it's actually already the case in version So I'm just going to sort groups from |
Yeah, without any default configuration, with @doc group: "Z group last"
def aaa, do: []
@doc group: "A Group second"
def zzz, do: []
def mmm, do: [] ...produces the following: So I'd rather keep that behaviour and document it, as there is now a second simple way to control ordering! (But I did make a change to sort those default groups by alphabetical order.) |
First attempt at the docs. Docs are hard, as always.
I splitted the different concepts (attaching to groups / descriptions / ordering) for clarity, not sure if it is OK.
We may want to fix default ordering (displaying groups from
:default_group_for_doc
before Types,Functions,Callbacks) and update the docs before merging this.